ODTypeList

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODTypeList

Superclasses
ODObject
Subclasses
none

An object of the ODTypeList class is an ordered set of ODType elements.

Description
A type list is an ordered set of elements, each specifying a different value. Elements are of the ODType type (page 876) and so are strings that can specify part kinds, focus types, or storage-unit types. Most often, all elements of a type list are part kinds. Because an ODType value is a pointer to an ISO string, any value to be added to a type list is copied first. That is, the pointer itself is not added to the list; instead, the string is copied and a pointer to the new copy is added to the list.
To create a type list, call the CreateTypeList method (page 662) of the storage-system object. If the call to that method specifies an existing type list, the new type list is initialized to contain a copy of each element in that list. The elements in the new list are in the same order as the elements of the original list. Otherwise, the new list is initialized to an empty list (a list with no elements).
You can add elements one at a time to the end of the type list. OpenDoc ensures that each element of a type list is unique; if you attempt to add a value that is already in the list, the list remains unchanged. You can remove elements from the list, test whether the list contains a particular element, and get the number of elements in the list. If you need to perform an operation for each element of the list, you can create an object of the ODTypeListIterator class (page 802), and use it to iterate through the list.

Methods
This section presents summary descriptions of the ODTypeList methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Manipulating Elements

AddLast
Adds an element to the end of this type list.
Remove
Removes the specified element from this type list.
Testing

Contains
Returns a Boolean value that indicates whether this type list contains the specified element.
Count
Returns the number of elements in this type list.
Creating an Iterator

CreateTypeListIterator

Creates a type-list iterator for this type list.

Methods
AddList
Contains
Count
CreateTypeListIterator
Remove